Package org.dogtagpki.server.rest.v1

Class ApiStatusHelper

java.lang.Object

org.dogtagpki.server.rest.v1.ApiStatusHelper

public class ApiStatusHelper
extends Object

Helper class for v1 REST API status checking. Centralizes the logic for reading build-time defaults and handling disabled/deprecated states.

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
ApiStatusHelper()

Method Summary

Modifier and Type	Method	Description
static boolean	checkApiStatus(String subsystemName, Set<Class<?>> classes, org.slf4j.Logger subsystemLogger, EngineConfig ec)	Check API status and handle disabled/deprecated states.
static String	getDefaultApiStatus()	Read the default v1 API status from build.properties.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

logger

public static org.slf4j.Logger logger

Constructor Details

ApiStatusHelper

public ApiStatusHelper()

Method Details

getDefaultApiStatus

public static String getDefaultApiStatus()

Read the default v1 API status from build.properties. This value is set at build time via Maven resource filtering.

Returns:

The default status: "enabled", "deprecated" or "disabled"

checkApiStatus

public static boolean checkApiStatus(String subsystemName,
 Set<Class<?>> classes,
 org.slf4j.Logger subsystemLogger,
 EngineConfig ec)

Check API status and handle disabled/deprecated states.

Parameters:

subsystemName - The name of the subsystem (e.g., "CA", "KRA", "PKI")

classes - The set of classes to modify if disabled or deprecated

subsystemLogger - The logger to use for warnings

cs - The subsystem configuration

Returns:

true if the Application constructor should return early (disabled state), false otherwise